<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dsitxss: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dsitxss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li class="current"><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('index.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">dsitxss Documentation</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This is main header file of the Xilinx MIPI DSI Tx Subsystem driver<b>MIPI DSI Tx Subsystem Overview</b></p>
<p>MIPI DSI Subsystem is collection of IP cores defines high speed serial interface between display peripheral and host processor. DSI Subsystem translate data received from a MIPI DSI Transmitter. The MIPI DSI Tx Subsystem is a plug-in solution for interfacing with MIPI DSI core. It hides all the complexities of programming the underlying cores from the end user.</p>
<p><b>Subsystem Features</b></p>
<p>MIPI DSI Tx Subsystem supports following features</p>
<ul>
<li>Support for 1 to 4 Data Lanes.</li>
<li>Line rates ranging from 80 to 1500 Mbps.</li>
<li>Different data type support(RGB888,RGB566,RGB666L,RGB666P).</li>
<li>Filtering of packets based on Virtual channel ID.</li>
<li>Single,Dual,Quad input pixel per beat</li>
</ul>
<p><b>Subsystem Configurations</b></p>
<p>The GUI in IPI allows for the following configurations</p>
<ul>
<li>Lanes ( 1 to 4 )</li>
<li>Pixel Format ( (RGB888,RGB566,RGB666L,RGB666P).</li>
<li>Number of Input Pixels per beat(1, 2, 4)</li>
<li>DPHY with/without Register interface</li>
<li>Line Rate</li>
<li>CRC Generation Enable In order to reduce resource usage, the DPHY can be configured to be without register interface with fixed functions. Static configuration parameters are stored in xdsitxss_g.c file, that gets generated when compiling the board support package (BSP). A table is defined where each entry contains configuration information for the instances of the subsystem in the design. This information includes the elected configuration, sub-cores used and their device ID, base addresses of memory mapped devices and address range available for subsystem frame/field buffers.</li>
</ul>
<p>The subsystem driver itself always includes the full software stack irrespective of the configuration selected. Generic API's are provided to interact with the subsystem and/or with the included sub -cores. At run-time the subsystem will query the static configuration and configures itself for supported use cases</p>
<p><b>Subsystem Driver Description</b></p>
<p>The subsystem driver provides an abstraction on top of the DSI and DPHY drivers.</p>
<p><b>Interrupt Service</b></p>
<p>The DSI TX subsystem supports 2 interrupts</p>
<ol type="1">
<li>Unsupported Data Type</li>
<li>Pixel Under flow error For Handling these interrupts, The users of this driver have to register this handler with the interrupt system and provide the callback functions by using XDSiTxSsSetCallback API</li>
</ol>
<p><b>Virtual Memory </b></p>
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
<p><b>Threads </b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b>Asserts</b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that application developers leave asserts on during development.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver Who Date    Changes
</p>
<hr/>
<p>
1.0 ram 11/02/16 Initial Release for MIPI DSI TX subsystem
1.1 sss 08/17/16 Added 64 bit support
    sss 08/26/16 Add "Command Queue Vacancy" API
                 API for getting pixel format
    ms  01/23/17 Modified xil_printf statement in main function for all
                 examples to ensure that "Successfully ran" and "Failed"
                 strings are available in all examples. This is a fix
                 for CR-965028.
    ms  03/17/17 Added readme.txt file in examples folder for doxygen
                 generation.
    ms  04/05/17 Added tabspace for return statements in functions of
                 <a class="el" href="xdsitxss__intr__example_8c.html" title="This file contains a design example using the XDsiTxSs driver with interrupts. ">xdsitxss_intr_example.c</a> for proper documentation
                 while generating doxygen.
</pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
